/*
 * Copyright 2010-2025 Hyland Software, Inc. and its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.activiti.engine.delegate.event;

/**
 * An {@link ActivitiEvent} related to an message being sent to an activity.
 *

 */
public interface ActivitiMessageEvent extends ActivitiActivityEvent {
    /**
     * @return the name of the message.
     */
    public String getMessageName();

    /**
     * @return the correlation key that was passed when sending the message. Returns null, if no correlation key was passed.
     */
    public String getMessageCorrelationKey();

    /**
     * @return the payload that was passed when sending the message. Returns null, if no payload was passed.
     */
    public Object getMessageData();

    /**
     * @return the business key from process instance sending the message. Returns null, if no business key was passed.
     */
    public String getMessageBusinessKey();
}
